-
Notifications
You must be signed in to change notification settings - Fork 81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(api): added openapi endpoints #1422
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Didn't we also add an endpoint for default build? Is it going to be added in another PR?
I'll add it in another PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've rewritten the descriptions slightly to address few things
- Actor capitalization
- Consistency
- Small descriptions to give more context instead just giving the note about similar endpoints
apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just one nit
example: Your Magic Actor | ||
version: | ||
type: string | ||
example: "1.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the quoting is inconsistent here, lets use single quotes everywhere (there are more places using double quotes, not just in this file)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, fixed in the files I've changed, but it is harder to change everywhere else. I think it should be fixed in lint, but we'll need to set up yaml lint for that...
Recently, we introduced two new endpoints that return the OpenAPI specification:
/acts/<actorId>/builds/<buildId>/openapi-specification
/actor-builds/<buildId>/openapi-specification
This PR updates the documentation to include these endpoints.
@TC-MO Let me, please, know if you think we should add any additional information 🙏